Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Follow up PR#866 ♻️ - 👌Minor cosmetic changes #965

Merged
merged 1 commit into from
Jan 22, 2022
Merged

Follow up PR#866 ♻️ - 👌Minor cosmetic changes #965

merged 1 commit into from
Jan 22, 2022

Conversation

jsnel
Copy link
Member

@jsnel jsnel commented Jan 21, 2022 •
edited by s-weigand
Loading

Improve spelling, fix typos.

Specific changes:

  • Use parameters instead of parameter where it makes sense.
  • Avoid using wildcards when importing from module

Checklist

  • ✔️ Passing the tests (mandatory for all PR's)

@jsnel
👌Minor cosmetic changes
ab8fc7f 
Improve spelling, fix typos.

Specific changes:
- Use parameters instead of parameter where it makes sense.
- Avoid using wildcards when importing from module
@github-actions
Copy link
Contributor

Binder 👈 Launch a binder notebook on branch jsnel/pyglotaran/refactor/improve-generators-PR

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 21, 2022

Sourcery Code Quality Report

✅  Merging this PR will increase code quality in the affected files by 0.01%.

Quality metrics Before After Change
Complexity 2.10 ⭐ 2.10 ⭐ 0.00
Method Length 34.52 ⭐ 34.49 ⭐ -0.03 👍
Working memory 6.75 🙂 6.75 🙂 0.00
Quality 81.33% ⭐ 81.34% ⭐ 0.01% 👍
Other metrics Before After Change
Lines 2079 2075 -4
Changed files Quality Before Quality After Quality Change
benchmark/pytest/analysis/test_optimization_group.py 84.65% ⭐ 84.65% ⭐ 0.00%
glotaran/builtin/io/yml/test/test_save_scheme.py 86.35% ⭐ 86.35% ⭐ 0.00%
glotaran/deprecation/deprecation_utils.py 70.38% 🙂 70.38% 🙂 0.00%
glotaran/deprecation/modules/examples/sequential.py 79.01% ⭐ 79.01% ⭐ 0.00%
glotaran/deprecation/modules/test/test_changed_imports.py 91.73% ⭐ 91.73% ⭐ 0.00%
glotaran/deprecation/modules/test/test_parameter_parameter_group.py 90.24% ⭐ 90.24% ⭐ 0.00%
glotaran/deprecation/modules/test/test_project_scheme.py 74.59% 🙂 74.59% 🙂 0.00%
glotaran/parameter/parameter.py 84.60% ⭐ 84.60% ⭐ 0.00%
glotaran/testing/simulated_data/parallel_spectral_decay.py 68.22% 🙂 68.52% 🙂 0.30% 👍
glotaran/testing/simulated_data/sequential_spectral_decay.py 68.22% 🙂 68.52% 🙂 0.30% 👍
glotaran/testing/simulated_data/shared_decay.py 88.29% ⭐ 88.29% ⭐ 0.00%

Here are some functions in these files that still need a tune-up:

File Function Complexity Length Working Memory Quality Recommendation
glotaran/deprecation/deprecation_utils.py check_qualnames_in_tests.deprecate_dict_entry 11 🙂 135 😞 14 😞 47.35% 😞 Try splitting into smaller methods. Extract out complex expressions
glotaran/parameter/parameter.py Parameter.markdown 13 🙂 148 😞 11 😞 48.86% 😞 Try splitting into smaller methods. Extract out complex expressions
glotaran/parameter/parameter.py Parameter.__init__ 1 ⭐ 70 🙂 16 ⛔ 63.36% 🙂 Extract out complex expressions
glotaran/deprecation/deprecation_utils.py check_qualnames_in_tests.module_attribute.deprecate_submodule 6 ⭐ 123 😞 8 🙂 64.34% 🙂 Try splitting into smaller methods
glotaran/deprecation/deprecation_utils.py check_qualnames_in_tests 6 ⭐ 83 🙂 10 😞 65.48% 🙂 Extract out complex expressions

Legend and Explanation

The emojis denote the absolute quality of the code:

  • ⭐ excellent
  • 🙂 good
  • 😞 poor
  • ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@jsnel jsnel mentioned this pull request Jan 21, 2022
Merged
4 tasks
@github-actions
Copy link
Contributor

Benchmark is done. Checkout the benchmark result page.
Benchmark differences below 5% might be due to CI noise.

Benchmark diff v0.5.1 vs. main

Parametrized benchmark signatures:

BenchmarkOptimize.time_optimize(index_dependent, grouped, weight)

All benchmarks:

       before           after         ratio
     [96b42630]       [ab8fc7f5]
     <v0.5.1>                   
       61.5±0.3ms       61.1±0.6ms     0.99  BenchmarkOptimize.time_optimize(False, False, False)
        73.7±20ms       65.7±0.4ms    ~0.89  BenchmarkOptimize.time_optimize(False, False, True)
       61.6±0.2ms       61.4±0.9ms     1.00  BenchmarkOptimize.time_optimize(False, True, False)
        68.1±30ms        67.1±20ms     0.99  BenchmarkOptimize.time_optimize(False, True, True)
       74.7±0.6ms       74.1±0.4ms     0.99  BenchmarkOptimize.time_optimize(True, False, False)
        79.6±30ms        78.6±30ms     0.99  BenchmarkOptimize.time_optimize(True, False, True)
       74.5±0.3ms       73.7±0.7ms     0.99  BenchmarkOptimize.time_optimize(True, True, False)
        80.5±30ms        83.2±40ms     1.03  BenchmarkOptimize.time_optimize(True, True, True)
             201M             202M     1.00  IntegrationTwoDatasets.peakmem_optimize
       2.07±0.04s       1.97±0.02s     0.95  IntegrationTwoDatasets.time_optimize
Benchmark diff main vs. PR

Parametrized benchmark signatures:

BenchmarkOptimize.time_optimize(index_dependent, grouped, weight)

All benchmarks:

       before           after         ratio
     [09de6b26]       [ab8fc7f5]
       61.0±0.3ms       61.1±0.6ms     1.00  BenchmarkOptimize.time_optimize(False, False, False)
        67.0±20ms       65.7±0.4ms     0.98  BenchmarkOptimize.time_optimize(False, False, True)
       61.8±0.5ms       61.4±0.9ms     0.99  BenchmarkOptimize.time_optimize(False, True, False)
        68.0±30ms        67.1±20ms     0.99  BenchmarkOptimize.time_optimize(False, True, True)
         74.3±1ms       74.1±0.4ms     1.00  BenchmarkOptimize.time_optimize(True, False, False)
        79.8±50ms        78.6±30ms     0.98  BenchmarkOptimize.time_optimize(True, False, True)
       74.4±0.2ms       73.7±0.7ms     0.99  BenchmarkOptimize.time_optimize(True, True, False)
        88.2±30ms        83.2±40ms     0.94  BenchmarkOptimize.time_optimize(True, True, True)
             203M             202M     0.99  IntegrationTwoDatasets.peakmem_optimize
       1.96±0.04s       1.97±0.02s     1.01  IntegrationTwoDatasets.time_optimize

@codecov
Copy link

codecov bot commented Jan 21, 2022 •
edited
Loading

Codecov Report

Merging #965 (ab8fc7f) into main (09de6b2) will decrease coverage by 0.0%.
The diff coverage is 92.3%.

Impacted file tree graph

@@           Coverage Diff           @@
##            main    #965     +/-   ##
=======================================
- Coverage   85.3%   85.3%   -0.1%     
=======================================
  Files         90      90             
  Lines       4857    4855      -2     
  Branches     912     912             
=======================================
- Hits        4147    4145      -2     
  Misses       561     561             
  Partials     149     149
Impacted Files Coverage Δ
glotaran/deprecation/deprecation_utils.py 100.0% <ø> (ø)
...lotaran/deprecation/modules/examples/sequential.py 81.8% <ø> (ø)
glotaran/parameter/parameter.py 95.5% <66.6%> (ø)
.../testing/simulated_data/parallel_spectral_decay.py 100.0% <100.0%> (ø)
...esting/simulated_data/sequential_spectral_decay.py 100.0% <100.0%> (ø)
glotaran/testing/simulated_data/shared_decay.py 100.0% <100.0%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 09de6b2...ab8fc7f. Read the comment docs.

joernweissenborn
joernweissenborn approved these changes Jan 22, 2022
View reviewed changes
Copy link
Member

@joernweissenborn joernweissenborn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@jsnel jsnel merged commit 07ebf7d into glotaran:main Jan 22, 2022
@s-weigand
Copy link
Member

Nice cleanup 🧹

@s-weigand s-weigand deleted the refactor/improve-generators-PR branch January 22, 2022 18:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joernweissenborn joernweissenborn joernweissenborn approved these changes

@s-weigand s-weigand Awaiting requested review from s-weigand s-weigand is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jsnel @s-weigand @joernweissenborn